Show:

Streams participants Class

Defined in: platform/plugins/Streams/handlers/Streams/participants/tool.php:7
Module: Streams-tools

This tool renders the participants in a stream

Constructor

Streams participants

(
  • [$options]
)

Defined in platform/plugins/Streams/handlers/Streams/participants/tool.php:7

Parameters:

  • [$options] Array optional

    Provide options for this tool

    • publisherId String

      The id of the publisher

    • streamName String

      The name of the stream

    • [stream] Streams_Stream optional

      You can pass this instead of publisherId and streamName

    • [invite] Array optional

      Pass an array here to pass as fields to Streams/participants/invite template, otherwise the invite button doesn't appear.

    • [max] Integer optional

      The number, if any, to show in the denominator of the summary

    • [maxShow=10] Integer optional

      The maximum number of participants to fetch for display

    • [onRefresh] Q.Event optional

      An event that occurs when the tool is refreshed

    • [showSummary] Boolean optional

      Whether to show a summary

    • [showBlanks] Boolean optional

      Whether to show blank avatars in place of remaining spots

    • [renderOnClient=false] Boolean optional

      If true, only the html container is rendered, so the client will do the rest.

Item Index